BBS Toolkit

home *** CD-ROM | disk | FTP | other *** search

/ BBS Toolkit / BBS Toolkit.iso / spitfire / alfv10.zip / !ALF.DOC next >

Wrap

Text File | 1992-03-29 | 21KB | 517 lines

ALF v1.0 Copyright (C) by Scott Fell,1992 A Thunderstorm Software production Released into the Public domain March 29, 1992 ----------------------------------------------------------- DISCLAIMER >> If you do not agree to this disclaimer, don't use this product! >> ALF is supplied AS-IS. ALF carries no warranty, expressed or implied. The person using ALF takes whole responsibility as to the quality and performance of this product. The author of this program assumes no responsibility for anything. ----------------------------------------------------------- S E C T I O N S ---------------------- <1> Why? <11> Contacting the Author <2> What does it do? <12> Anything ELSE? <3> Installation <13> Bugs <4> If you have a Problem... <14> Limits <5> Compatibility <15> ALF and DesQview <6> CD-ROM users <--> REFERENCE <7> Maintenence <1> Headers <8> Just a note <2> Step Explanation <9> How much does it cost? <3> Submissions <10> Anything else? <4> Possible Problems... ---------------------- Why? ---- I had another program that made up headers for the file-lists, and I loved the concept, and loved how it worked and kept up-to-date, but they wanted a 10$ registration fee before it would actually run by itself, and that huge "UNREGISTERED" notice would disappear. I didn't like it, so I stopped using it, and decided to write my own. So here it is- my submission to the SpitFire world... Enjoy! What does ALF do? ----------------- It's a down-and-dirty header-maker for your SpitFire file-lists. Down-and-dirty meaning it won't clean your monitor, wash your car, or water your lawn, but it does what it's supposed to do, without fooling around with any unnecessary options. Installation ------------ Knowing that you'd rather get it running than look over instructions for an hour, use the following steps to get going ASAP. However: I HIGHLY suggest taking at least a quick look-through of the rest of this DOC file. >>>>> DO NOT SKIP ANY STEPS!!!! <<<<< ***If you have CD-ROM areas, you need to read the CD-ROM section!!!*** 1) Put all the EXE files into your SpitFire home directory (Where your SFFAREA.DAT file is located). 2) Execute ALFBAK.EXE 3) Execute SFF_BAK.BAT (This batch file will be created for you when you execute ALFBAK.EXE). Run this file at this point in time, and do not run it again until you're POSITIVE that ALF will work with your system. 4) Execute ALF whenever you want to update the headers in your file-lists. (As an event, it will update your headers as often as you like, and you won't have to worry about it) 5) Goto step 4 >>If you're interested in knowing exactly what these steps do, consult the last part of this DOC file. There are more specific explanations there. If you have a problem.. ----------------------- If your computer belched when you ran it, and your file-listings are messed up, run !ALF once more. If the listings are still messed up, then run the program BAD!_ALF, and then execute UNDO_ALF (a batch file that is created by BAD!_ALF), and your file-lists will be returned to how they were prior to running ALF. I don't anticipate problems, but someone somewhere is going to have one, and this is the easy way to get back to normal. If you want to try to use !ALF again, after you've had a problem, you can start at step 4 and see if it works. If it doesn't work this time, run UNDO_ALF once more. NOTE: CD-ROM users beware! If your file-listings from the CD-ROM are not in the EXACT same format as v3.1 (or v3.2) then you will have your file-areas screwed up. Compatibility ------------- ALF will work on SpitFire v3.1. It will also work with v3.2, BUT, if you have the multiline option for file-descriptions active (for version 3.2), the file-counter will be wrong. If you want to test it out, please be sure to let me know!.. With the ALFBAK and BAD!_ALF, even if it does mess up, you have a 2 minute fix-process before everything is back to normal. NOTE: If you've added extended descriptions to your file- like a second line, such as this, DATA1.GIF 62,464 08-13-91 Data of Star Trek: The Next Generation as Sherlock Holmes -Episode 34 NOTE <continued> everything will be correct except for the number of files in the area. ALF will tell you that you have more files than you do, because it counts the number of lines that are used, not the number of filenames. CD-ROM users: ------------ When executing any of the programs in this package, you need to be aware of just one command-line parameter. It is the path to your CD-ROM display files. In most cases, this file-path is C:\SF\DISPLAY, which is the default setting. If your configuration is different, you need to enter the path to your display files. Just enter it on the command-line without any special parameters. Remember to NOT use the following backslash! If you do, the program will exit with an error, and halt. If no path is specified, the default directory is used (C:\SF\DISPLAY). NOTE: If the structure of your CD-ROM display files is different from that of SpitFire, you WILL run into problems. As long as there is a comma in the 18th space of the line, all will be well in the world. If there is no comma in the 18th character, then that line will be omitted in the final product. (ie- if none of the lines have commas in the 18th place, ALL of the listings will be erased). If the comma is there, then all of your file-lists will be just fine. If it is not there, you might end up with no files listed in that area. So here's what you do- On the command-line, instead of specifying the ACTUAL directory where the display files are, specify a DIFFERENT directory (That actually exists) on your disk where NO CD-ROM display files are. ALF will then skip the processing of your CD-ROM areas. The regular file-areas will continue to be updated, but ALF will now ignore your CD-ROM areas. NOTE: There is a utility on Buffalo Creek's BBS that will add commas in the right places in your CD-ROM areas, assuming that they're not exactly the same as SpitFire's format. It is conceivable that ALF will eventually grow to include the different CD-ROM listing formats. If you have a format that you want supported, please include a sample of the file listings, and send it off to the author. Maintenance ----------- Every once in a while (you should run this by YOURSELF), you will probably want to execute the program ALFBAK.EXE, and then run the batch file (SFF_BAK.BAT) that it creates. When you do this, the CURRENT SFFILES.BBS will be copied into backup files. This way, you can be assured that the back-ups of your SFFILES.BBS files will be kept current, and you won't have to mess with adding back in all the files that you've added to your areas since you last ran ALFBAK. (This does the same with CD-ROM file-area lists) Just a note ----------- This version of ALF does NOT do anything about the file upload-paths. it will not update or create headers for the upload areas. If your upload and download are the same area, then the SFFILES.BBS file will be updated. If they are separate, the download section will be updated while the upload section will not. If this presents a problem, be sure to let me know! How much does it cost? ---------------------- A postage stamp. Send me your comments, suggestions, theories on relativity, or whatever to: Quandra: TIE c/o Scott Fell P.O. Box 855 Flagstaff, Az. 86004 Or, you can E-mail me at any of the addresses listed below under "Contacting the author". Donations are not required, but are GREATLY appreciated- and what do you get for a donation?... A personally compiled version, of course! :)... If you'd like, I can add another line at the top of the header that has your BBS name on it, and your number at the bottom-right corner. - it would look something like: <─────────────────────────────────────────────────> Quandra: The Information Exchange <─────────────────────────────────────────────────────────> A R 9 E A <─────────────────────────────────────────────────────────────────> GIFs A-F <──────────────────────> <──────────────────────> <─────────────────────> 493 files 51,097,928 3/7/1992 <──────────────────────────────────────────────────────────[ALF v1.0#001]─────> Or, possibly something more attractive- (so I admit I'm no artist 8^))- let me know what you think... I think 7$ is fair for me to send you the stuff on disk... or, if you want to call up Quandra, and download it for yourself, I think 4$ would be more in the realm of reasonable. US funds only, please! Do NOT send cash! (It tends to disappear mysteriously in the mail) Checks or Money orders only. Anything else? -------------- Future versions are a definite possibility, but, it all depends on how many people actually use this program. 'Response' is the key-word here. If I know that people are actually using this program, then I'll be interested in putting out future versions. If not, then there's really no reason to. Contacting The Author --------------------- In order of speed.. Fidonet: 1:304/7 -- Send netmail to this address. If you've donated, I'll send it back. If you haven't, the letter will be placed on "Hold" until you poll again. Please use this method if at all possible. Internet: Quandra@grdpnt.flagstaff.az.us -- Mail goes through almost as quick through here BBS: Quandra: The Information Exchange BBS (602)527-8895 24hrs/7days To: SysOp -- This is probably the fastest way to reach me Mailing Address: Quandra: TIE c/o Scott Fell P.O. Box 855 Flagstaff, Az. 86004 -- This is probably the slowest way to reach me ;-) Anything ELSE? -------------- This program works just fine on my own system... it runs as an event every night, as a matter of fact... If you run across any problems, be sure to let me know ASAP!... It's got my name on it, so I want it to be as good as possible! Suggestions on improvements, possible other programs, etc are ALWAYS welcome! Enjoy it! -Scott Bugs ---- If you discover a bug in the program, (and there always are), please let me know ASAP, so I can get the problem fixed, and have the new version available quickly. If you would like to make a suggestion to change the way ALF works, interfaces, etc., send me a note. I will review all proposed changes. If your suggestion makes it into a final copy of ALF, you will be noted for your contribution in the CHANGES.ALF file that will accompany future versions. Limits ------ The only real limit I know of is 600 lines-worth of text in your file. If your file-listing is longer than 600 lines <and if it is, you've got a horrendously HUGE listing that people should probably not have to sort through to get to the file that they want>, then ALF will halt with a run-time error. I limit it to 600 because of memory requirements. ALF runs quite well within a 128k window in my DesQview program. I don't know exactly how much memory is required, and I really don't know of a way to test it, either <any Pascalers out there who know how?>. The only other thing I can think of is if your listings are longer than the 80 columns provided on a single screen. If you have more than 80 characters, then your listings will most probably be chopped off. ALF and DesQview ---------------- Seems to work just fine with DesQview. You will probably experience a little bleed-through, 'cause I dunno how to turn it off ;-). After the initial screen-write, you will only be disturbed by the monitor telling you which file-area it's working on, and then when it's done. I have no experience with Windows, or DDos, or other multitaskers, so, those of you who use them, please let me know how they work! R E F E R E N C E --------------------- ------------------------- --------------------- ------------------------- ----------------- --------------------------- ------------------------------ --------- -------------------------------- ----------------------------------- --- ------------------------------------ ------------------------------------------------------------------------------ Headers ------- A regular header created by ALF will look something like this: --- <─────────────────────────────────────────────────────────> A R 12 E A <─────────────────────────────────────────────────────────────────> Modem goodies <──────────────────────> <──────────────────────> <─────────────────────> 446 files 16,234,758 3/7/1992 <──────────────────────────────────────────────────────────────[ALF v1.0]─────> 16550S.ZIP 5,943 04-11-90 Toggle the NS16550A FIFO buffer, w/TP source 16550S13.ZIP 10,166 03-29-91 Toggle the NS16550A FIFO buffer, w/TP source 1PR2A.ARC 2,092 05-18-89 Swaps LPT1 and LPT2 printer ports 34INSTAL.ZIP 3,695 03-19-90 Adds DOS support for COMM ports 3 and 4 387.ZIP 24,147 05-23-90 Software emulation of 80387 coprocessor chip 387SXBUG.ZIP 5,436 03-15-91 Check for bad 386sx motherboard And on and on... Step Explanation ---------------- If you're interested in exactly how this program works, this section is for you... 1) Put all the EXE files into your SpitFire home directory (Where your SFFAREA.DAT file is located). This puts the programs where they can find the SFFAREA.DAT file, without having to search for it. It really doesn't matter where the file is; as long as it's current, directory, !ALF will work just fine. 2) Execute ALFBAK.EXE This goes through your SFFILES.BBS file, and makes up a batch file (called MAKEBAKS.BAT) that will go through your file-areas, and create backups of your SFFILES.BBS files. The backups will be called SFFILES.BAK for each of your areas. 3) Execute MAKEBAKS.BAT NEVER run this batch before you're POSITIVE that !ALF will work with your system!!!! This is the batch file created by ALFBAK.EXE. It actually goes through your file-directories, and does this command: "Copy SFFILES.BBS SFFILES.BAK" in each of the areas, providing an exact copy of each of your file-listings. This is very handy if something goes wrong. Your backups will already be created for you. In case you're missing an SFFILES.BBS, you will notice an error when your batch file is running. I left out the "Echo Off" so it would be easier to find out where any potential problems were. 4) Execute !ALF whenever you want to update the headers in your file-lists. (As an event, it will update your headers as often as you like, and you won't have to worry about it) !ALF is the program that goes through your file-listings, creates the headers, and inserts the header before the first line of the file. !ALF assumes that the first file in the area will have a comma in the 18th space (between the thousands and the hundreds in the file-descriptions). If it is not there, it assumes that that line is a comment-line (or possibly another header), and omits it from the final product. If you've messed with your descritiptions at all, you need to be VERY sure that the commas are in the 18th space, or you'll get files omitted that shouldn't have been. Submissions ----------- Suggestions: Are greatly appreciated. If your suggested change makes it into a future edition, your name and BBS will be noted in the CHANGES.ALF file, included in future archives of ALF. Problems: If you have one, there are about 4 addresses where you can reach me. If you wish to send netmail, your response will be posted within 24 hours, and placed on hold until you poll again. The "On Hold" reply will wait inside FroDo until you pick it up. Replies older than a month that have not been picked up will be deleted. Internet is probably the second-fastest way to do things, and one of the most conveninet. Calling my BBS is another option, or, you can also use the good 'ol U.S. Postal Service.. (please include an extra stamp for the return postage!) Problems -------- For any problem that you have, you can always fix it with the UNDO_ALF.EXE program I've provided in the package. It will create a batch file that will go through the file-areas, and copy the SFFILES.BAK file (that the MAKBAKS program created) back to the original SFFILES.DAT. If you've followed the steps correctly, there is no problem that cannot be fixed simply and easily. You have that assurance no matter what happens, so long as YOU don't change your SFFILES.BAK files. None of the programs in this package deal with the SFFILES.BAK files, so, they will remain the same way they were when they were created originally, assuming no other program <or you> changes the data contained in them. Conceivable problems include: Files that are greater in size than 999,999 bytes. If these listings aren't put-together the way "MKSFFBBS.EXE" does <A freeware file-utility from Mike Woltz (C)>, then it will count <incorrectly> the number of bytes in that file area. No other damage will result. One more time! CD-ROM users need to be very careful when they run !ALF. If you know already that !ALF will not work with your particular format, then don't run it on your CD-ROM areas! If you have file-areas configged in your SFFAREA.DAT file that are not existant on the disk, !ALF will exit with an error, and halt. You will want to run the program while you're watching it, so that you will know if it's getting through all of your file-areas or not. There is a fix for this problem, though- eliminate the unnecessary file-area-definitions from the SFFAREA.DAT file. If your file-descriptions are in some odd format, it is possible that ALF will not know that certain lines are files, and omit them. This is only possible in CD-ROM areas, or in areas that you made descriptions for yourself, in which the descriptions are different from the common form. (ie the comma in the 18th space). <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<->>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> This file courtesy of Quandra: The Information Exchange BBS (602)527-8895 24 hours 7 days Central point of distribution for Thunderstorm Software products <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<->>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> SpitFire is a Copyright of Buffalo Creek Software and Mike Woltz